home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / elispman.lha / elispman / elisp-37 (.txt) < prev    next >
GNU Info File  |  1993-05-11  |  26KB  |  447 lines

  1. This is Info file elisp, produced by Makeinfo-1.52 from the input file
  2. elisp.texi.
  3.    This file documents GNU Emacs Lisp.
  4.    This is edition 2.0 of the GNU Emacs Lisp Reference Manual, for
  5. Emacs Version 19.
  6.    Published by the Free Software Foundation, 675 Massachusetts Avenue,
  7. Cambridge, MA 02139 USA
  8.    Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Foundation.
  20. File: elisp,  Node: Process Internals,  Prev: Window Internals,  Up: Object Internals
  21. Process Internals
  22. -----------------
  23.                                       The fields of a process are:
  24.                                   `name'
  25.                                         A string, the name of the
  26.                                         process.
  27.                                   `command'
  28.                                         A list containing the command
  29.                                         arguments that were used to
  30.                                         start this process.
  31.                                   `filter'
  32.                                         A function used to accept
  33.                                         output from the process instead
  34.                                         of a buffer, or `nil'.
  35.                                   `sentinel'
  36.                                         A function called whenever the
  37.                                         process receives a signal, or
  38.                                         `nil'.
  39.                                   `buffer'
  40.                                         The associated buffer of the
  41.                                         process.
  42.                                   `pid'
  43.                                         An integer, the Unix process ID.
  44.                                   `childp'
  45.                                         A flag, non-`nil' if this is
  46.                                         really a child process.  It is
  47.                                         `nil' for a network connection.
  48.                                   `flags'
  49.                                         A symbol indicating the state
  50.                                         of the process.  Possible
  51.                                         values include `run', `stop',
  52.                                         `closed', etc.
  53.                                   `reason'
  54.                                         An integer, the Unix signal
  55.                                         number that the process
  56.                                         received that caused the
  57.                                         process to terminate or stop.
  58.                                         If the process has exited, then
  59.                                         this is the exit code it
  60.                                         specified.
  61.                                   `mark'
  62.                                         A marker indicating the
  63.                                         position of end of last output
  64.                                         from this process inserted into
  65.                                         the buffer.  This is usually
  66.                                         the end of the buffer.
  67.                                   `kill_without_query'
  68.                                         A flag, non-`nil' meaning this
  69.                                         process should not cause
  70.                                         confirmation to be needed if
  71.                                         Emacs is killed.
  72. File: elisp,  Node: Standard Errors,  Next: Standard Buffer-Local Variables,  Prev: GNU Emacs Internals,  Up: Top
  73. Standard Errors
  74. ***************
  75.                                       Here is the complete list of the
  76. error symbols in standard Emacs, grouped by concept.  The list includes
  77. each symbol's message (on the `error-message' property of the symbol),
  78. and a cross reference to a description of how the error can occur.
  79.                                       Each error symbol has an
  80. `error-conditions' property which is a list of symbols.  Normally, this
  81. list includes the error symbol itself, and the symbol `error'.
  82. Occasionally it includes additional symbols, which are intermediate
  83. classifications, narrower than `error' but broader than a single error
  84. symbol.  For example, all the errors in accessing files have the
  85. condition `file-error'.
  86.                                       As a special exception, the error
  87. symbol `quit' does not have the condition `error', because quitting is
  88. not considered an error.
  89.                                       *Note Errors::, for an
  90. explanation of how errors are generated and handled.
  91.                                   `SYMBOL'
  92.                                         STRING; REFERENCE.
  93.                                   `error'
  94.                                         `"error"'
  95.                                         *Note Errors::.
  96.                                   `quit'
  97.                                         `"Quit"'
  98.                                         *Note Quitting::.
  99.                                   `args-out-of-range'
  100.                                         `"Args out of range"'
  101.                                         *Note Sequences Arrays
  102.                                         Vectors::.
  103.                                   `arith-error'
  104.                                         `"Arithmetic error"'
  105.                                         See `/' and `%' in *Note
  106.                                         Numbers::.
  107.                                   `beginning-of-buffer'
  108.                                         `"Beginning of buffer"'
  109.                                         *Note Motion::.
  110.                                   `buffer-read-only'
  111.                                         `"Buffer is read-only"'
  112.                                         *Note Read Only Buffers::.
  113.                                   `end-of-buffer'
  114.                                         `"End of buffer"'
  115.                                         *Note Motion::.
  116.                                   `end-of-file'
  117.                                         `"End of file during parsing"'
  118.                                         This is not a `file-error'.
  119.                                         *Note Input Functions::.
  120.                                   `file-error'
  121.                                         This error, and its
  122.                                         subcategories, do not have
  123.                                         error-strings, because the
  124.                                         error message is constructed
  125.                                         from the data items alone when
  126.                                         the error condition
  127.                                         `file-error' is present.
  128.                                         *Note Files::.
  129.                                   `file-locked'
  130.                                         This is a `file-error'.
  131.                                         *Note File Locks::.
  132.                                   `file-already-exists'
  133.                                         This is a `file-error'.
  134.                                         *Note Writing to Files::.
  135.                                   `file-supersession'
  136.                                         This is a `file-error'.
  137.                                         *Note Buffer Modification::.
  138.                                   `invalid-function'
  139.                                         `"Invalid function"'
  140.                                         *Note Classifying Lists::.
  141.                                   `invalid-read-syntax'
  142.                                         `"Invalid read syntax"'
  143.                                         *Note Input Functions::.
  144.                                   `invalid-regexp'
  145.                                         `"Invalid regexp"'
  146.                                         *Note Regular Expressions::.
  147.                                   `no-catch'
  148.                                         `"No catch for tag"'
  149.                                         *Note Catch and Throw::.
  150.                                   `search-failed'
  151.                                         `"Search failed"'
  152.                                         *Note Searching and Matching::.
  153.                                   `setting-constant'
  154.                                         `"Attempt to set a constant
  155.                                         symbol"'
  156.                                         The values of the symbols `nil'
  157.                                         and `t' may not be changed.
  158.                                         *Note Variables that Never
  159.                                         Change: Constant Variables.
  160.                                   `void-function'
  161.                                         `"Symbol's function definition
  162.                                         is void"'
  163.                                         *Note Function Cells::.
  164.                                   `void-variable'
  165.                                         `"Symbol's value as variable is
  166.                                         void"'
  167.                                         *Note Accessing Variables::.
  168.                                   `wrong-number-of-arguments'
  169.                                         `"Wrong number of arguments"'
  170.                                         *Note Classifying Lists::.
  171.                                   `wrong-type-argument'
  172.                                         `"Wrong type argument"'
  173.                                         *Note Type Predicates::.
  174. File: elisp,  Node: Standard Buffer-Local Variables,  Next: Standard Keymaps,  Prev: Standard Errors,  Up: Top
  175. Buffer-Local Variables
  176. **********************
  177.                                       The table below shows all of the
  178. variables that are automatically local (when set) in each buffer in
  179. Emacs Version 18 with the common packages loaded.
  180.                                   `abbrev-mode'
  181.                                         *note Abbrevs::.
  182.                                   `auto-fill-function'
  183.                                         *note Auto Filling::.
  184.                                   `buffer-auto-save-file-name'
  185.                                         *note Auto-Saving::.
  186.                                   `buffer-backed-up'
  187.                                         *note Backup Files::.
  188.                                   `buffer-display-table'
  189.                                         *note Display Tables::.
  190.                                   `buffer-file-name'
  191.                                         *note Buffer File Name::.
  192.                                   `buffer-file-number'
  193.                                         *note Buffer File Name::.
  194.                                   `buffer-file-truename'
  195.                                         *note Buffer File Name::.
  196.                                   `buffer-offer-save'
  197.                                         *note Saving Buffers::.
  198.                                   `buffer-read-only'
  199.                                         *note Read Only Buffers::.
  200.                                   `buffer-saved-size'
  201.                                         *note Point::.
  202.                                   `buffer-undo-list'
  203.                                         *note Undo::.
  204.                                   `case-fold-search'
  205.                                         *note Searching and Case::.
  206.                                   `ctl-arrow'
  207.                                         *note Usual Display::.
  208.                                   `default-directory'
  209.                                         *note System Environment::.
  210.                                   `fill-column'
  211.                                         *note Auto Filling::.
  212.                                   `left-margin'
  213.                                         *note Indentation::.
  214.                                   `local-abbrev-table'
  215.                                         *note Abbrevs::.
  216.                                   `local-write-file-hooks'
  217.                                         *note Saving Buffers::.
  218.                                   `major-mode'
  219.                                         *note Mode Help::.
  220.                                   `mark-active'
  221.                                         *note The Mark::.
  222.                                   `mark-ring'
  223.                                         *note The Mark::.
  224.                                   `minor-modes'
  225.                                         *note Minor Modes::.
  226.                                   `mode-line-format'
  227.                                         *note Mode Line Data::.
  228.                                   `mode-name'
  229.                                         *note Mode Line Variables::.
  230.                                   `overwrite-mode'
  231.                                         *note Insertion::.
  232.                                   `paragraph-separate'
  233.                                         *note Standard Regexps::.
  234.                                   `paragraph-start'
  235.                                         *note Standard Regexps::.
  236.                                   `require-final-newline'
  237.                                         *note Insertion::.
  238.                                   `selective-display'
  239.                                         *note Selective Display::.
  240.                                   `selective-display-ellipses'
  241.                                         *note Selective Display::.
  242.                                   `tab-width'
  243.                                         *note Usual Display::.
  244.                                   `truncate-lines'
  245.                                         *note Truncation::.
  246. File: elisp,  Node: Standard Keymaps,  Next: Standard Hooks,  Prev: Standard Buffer-Local Variables,  Up: Top
  247. Standard Keymaps
  248. ****************
  249.                                       The following symbols are used as
  250. the names for various keymaps.  Some of these exist when Emacs is first
  251. started, others are only loaded when their respective mode is used.
  252. This is not an exhaustive list.
  253.                                       Almost all of these maps are used
  254. as local maps.  Indeed, of the modes that presently exist, only Vip
  255. mode and Terminal mode ever change the global keymap.
  256.                                   `Buffer-menu-mode-map'
  257.                                         A full keymap used by Buffer
  258.                                         Menu mode.
  259.                                   `c-mode-map'
  260.                                         A sparse keymap used in C mode
  261.                                         as a local map.
  262.                                   `command-history-map'
  263.                                         A full keymap used by Command
  264.                                         History mode.
  265.                                   `ctl-x-4-map'
  266.                                         A sparse keymap for subcommands
  267.                                         of the prefix `C-x 4'.
  268.                                   `ctl-x-map'
  269.                                         A full keymap for `C-x'
  270.                                         commands.
  271.                                   `debugger-mode-map'
  272.                                         A full keymap used by Debugger
  273.                                         mode.
  274.                                   `dired-mode-map'
  275.                                         A full keymap for `dired-mode'
  276.                                         buffers.
  277.                                   `doctor-mode-map'
  278.                                         A sparse keymap used by Doctor
  279.                                         mode.
  280.                                   `edit-abbrevs-map'
  281.                                         A sparse keymap used in
  282.                                         `edit-abbrevs'.
  283.                                   `edit-tab-stops-map'
  284.                                         A sparse keymap used in
  285.                                         `edit-tab-stops'.
  286.                                   `electric-buffer-menu-mode-map'
  287.                                         A full keymap used by Electric
  288.                                         Buffer Menu mode.
  289.                                   `electric-history-map'
  290.                                         A full keymap used by Electric
  291.                                         Command History mode.
  292.                                   `emacs-lisp-mode-map'
  293.                                         A sparse keymap used in Emacs
  294.                                         Lisp mode.
  295.                                   `function-keymap'
  296.                                         The keymap for the definitions
  297.                                         of keypad and function keys.
  298.                                         If there are none, then it
  299.                                         contains an empty sparse keymap.
  300.                                   `fundamental-mode-map'
  301.                                         The local keymap for
  302.                                         Fundamental mode.
  303.                                         It is empty and should not be
  304.                                         changed.
  305.                                   `Helper-help-map'
  306.                                         A full keymap used by the help
  307.                                         utility package.
  308.                                         It has the same keymap in its
  309.                                         value cell and in its function
  310.                                         cell.
  311.                                   `Info-edit-map'
  312.                                         A sparse keymap used by the `e'
  313.                                         command of Info.
  314.                                   `Info-mode-map'
  315.                                         A sparse keymap containing Info
  316.                                         commands.
  317.                                   `isearch-mode-map'
  318.                                         A keymap that defines the
  319.                                         characters you can type within
  320.                                         incremental search.
  321.                                   `lisp-interaction-mode-map'
  322.                                         A sparse keymap used in Lisp
  323.                                         mode.
  324.                                   `lisp-mode-map'
  325.                                         A sparse keymap used in Lisp
  326.                                         mode.
  327.                                   `mode-specific-map'
  328.                                         The keymap for characters
  329.                                         following `C-c'.  Note, this is
  330.                                         in the global map.  This map is
  331.                                         not actually mode specific: its
  332.                                         name was chosen to be
  333.                                         informative for the user in
  334.                                         `C-h b' (`display-bindings'),
  335.                                         where it describes the main use
  336.                                         of the `C-c' prefix key.
  337.                                   `occur-mode-map'
  338.                                         A local keymap used in Occur
  339.                                         mode.
  340.                                   `query-replace-map'
  341.                                         A local keymap used for
  342.                                         responses in `query-replace'
  343.                                         and related commands; also for
  344.                                         `y-or-n-p' and `map-y-or-n-p'.
  345.                                         The functions that use this map
  346.                                         do not support prefix keys;
  347.                                         they look up one event at a
  348.                                         time.
  349.                                   `text-mode-map'
  350.                                         A sparse keymap used by Text
  351.                                         mode.
  352.                                   `view-mode-map'
  353.                                         A full keymap used by View mode.
  354. File: elisp,  Node: Standard Hooks,  Next: Index,  Prev: Standard Keymaps,  Up: Top
  355. Standard Hooks
  356. **************
  357.                                       The following is a list of hook
  358. variables which let you provide functions to be called from within
  359. Emacs on suitable occasions.
  360.                                       Most of these variables have
  361. names ending with `-hook' are "normal hooks", that are run with
  362. `run-hooks'.  The value of such a hook is a list of functions.  The
  363. recommended way to put a new function on such a hook is to call
  364. `add-hook'.  *Note Hooks::, for more information about using hooks.
  365.                                       The variables whose names end in
  366. `-function' have single functions as their values.  Usually there is a
  367. specific reason why the variable is not a normal hook, such as, the
  368. need to pass an argument to the function.  (In older Emacs versions,
  369. some of these variables had names ending in `-hook' even though they
  370. were not normal hooks.)
  371.                                       The variables whose names end in
  372. `-hooks' have lists of functions as their values, but these functions
  373. are called in a special way (they are passed arguments, or else their
  374. values are used).
  375.                                   `activate-mark-hook'
  376.                                   `after-change-function'
  377.                                   `after-init-hook'
  378.                                   `auto-fill-function'
  379.                                   `auto-save-hook'
  380.                                   `before-change-function'
  381.                                   `before-init-hook'
  382.                                   `blink-paren-function'
  383.                                   `c-mode-hook'
  384.                                   `command-history-hook'
  385.                                   `comment-indent-function'
  386.                                   `deactivate-mark-hook'
  387.                                   `dired-mode-hook'
  388.                                   `disabled-command-hook'
  389.                                   `edit-picture-hook'
  390.                                   `electric-buffer-menu-mode-hook'
  391.                                   `electric-command-history-hook'
  392.                                   `electric-help-mode-hook'
  393.                                   `emacs-lisp-mode-hook'
  394.                                   `find-file-hooks'
  395.                                   `find-file-not-found-hooks'
  396.                                   `first-change-hook'
  397.                                   `fortran-comment-hook'
  398.                                   `fortran-mode-hook'
  399.                                   `ftp-setup-write-file-hooks'
  400.                                   `ftp-write-file-hook'
  401.                                   `indent-mim-hook'
  402.                                   `LaTeX-mode-hook'
  403.                                   `ledit-mode-hook'
  404.                                   `lisp-indent-function'
  405.                                   `lisp-interaction-mode-hook'
  406.                                   `lisp-mode-hook'
  407.                                   `m2-mode-hook'
  408.                                   `mail-mode-hook'
  409.                                   `mail-setup-hook'
  410.                                   `medit-mode-hook'
  411.                                   `mh-compose-letter-hook'
  412.                                   `mh-folder-mode-hook'
  413.                                   `mh-letter-mode-hook'
  414.                                   `mim-mode-hook'
  415.                                   `news-mode-hook'
  416.                                   `news-reply-mode-hook'
  417.                                   `news-setup-hook'
  418.                                   `nroff-mode-hook'
  419.                                   `outline-mode-hook'
  420.                                   `plain-TeX-mode-hook'
  421.                                   `pre-abbrev-expand-hook'
  422.                                   `pre-command-hook'
  423.                                   `post-command-hook'
  424.                                   `prolog-mode-hook'
  425.                                   `protect-innocence-hook'
  426.                                   `rmail-edit-mode-hook'
  427.                                   `rmail-mode-hook'
  428.                                   `rmail-summary-mode-hook'
  429.                                   `scheme-indent-hook'
  430.                                   `scheme-mode-hook'
  431.                                   `scribe-mode-hook'
  432.                                   `shell-mode-hook'
  433.                                   `shell-set-directory-error-hook'
  434.                                   `suspend-hook'
  435.                                   `suspend-resume-hook'
  436.                                   `temp-buffer-show-function'
  437.                                   `term-setup-hook'
  438.                                   `terminal-mode-hook'
  439.                                   `terminal-mode-break-hook'
  440.                                   `TeX-mode-hook'
  441.                                   `text-mode-hook'
  442.                                   `vi-mode-hook'
  443.                                   `view-hook'
  444.                                   `window-setup-hook'
  445.                                   `write-contents-hooks'
  446.                                   `write-file-hooks'
  447.